Fix: Correct inaccurate Email as Username prerequisite for all affected versions (Product IS issue #26241) #5703
Conversation
…ed versions (product-is#26241) - Removed incorrect statement that Email as Username is mandatory - Added comprehensive Prerequisites section with username requirements and login scenarios - Clarified distinction between username format requirements during user creation and login experience - Documented Scenario A (Multi-Attribute Login disabled) and Scenario B (Multi-Attribute Login enabled) - Added important note about existing users with non-email usernames - This single change affects all IS versions (7.0.0, 7.1.0, 7.2.0) via shared include file
|
wso2-engineering-bot seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
|
Caution Review failedThe pull request is closed. WalkthroughAdded a Prerequisites section requiring username to be an email whose domain matches a configured discovery domain, clarified two login scenarios for email-domain-based organization discovery (Multi-Attribute Login on/off), added MFA/user-edge-case warning, and removed a prior product-specific instruction about enabling email as username. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant App
participant AuthServer
rect `#f8fbff`
Note right of App: Organization discovery step
end
User->>App: Submit credentials (username or email)
alt Multi-Attribute Login OFF
App->>AuthServer: Use full email as username for discovery
AuthServer-->>App: Map organization by email domain
else Multi-Attribute Login ON
App->>AuthServer: Send username + email attribute for discovery
AuthServer-->>App: Map organization by email attribute domain
end
App->>User: Proceed with authentication (MFA if required)
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Possibly related PRs
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
en/includes/guides/organization-management/organization-discovery/email-domain-based-organization-discovery.md (1)
36-49: Login scenarios clearly differentiate behavior based on Multi-Attribute Login configuration.Scenario A straightforwardly describes the standard flow, while Scenario B explains the enhanced flexibility and explicitly recommends it. The important note correctly addresses the experience for existing non-email username users, which is crucial for migration paths.
However, per the PR objectives, the change goal was to clarify that "Email as Username" is not a mandatory prerequisite. Consider adding an explicit statement like: "Note: This feature does not require the 'Email as Username' capability to be enabled." This would make the fix more obvious to readers who may have encountered the previous documentation.
Optional verification: Confirm that the Multi-Attribute Login link at line 46 (
{{base_path}}/guides/authentication/configure-multi-attribute-login/) is accurate and current in all supported versions (IS 7.0.0, 7.1.0, 7.2.0).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
en/includes/guides/organization-management/organization-discovery/email-domain-based-organization-discovery.md(1 hunks)
🔇 Additional comments (2)
en/includes/guides/organization-management/organization-discovery/email-domain-based-organization-discovery.md (2)
24-49: Comprehensive Prerequisites section successfully clarifies requirements and scenarios.The new Prerequisites section effectively communicates the key requirements for email domain-based organization discovery. The structure is logical, moving from username requirements during user creation to two distinct login scenarios based on Multi-Attribute Login configuration. The important note about existing users with non-email usernames (lines 48-49) correctly identifies a critical edge case.
28-34: Username requirements are clearly articulated with good use of examples.The subsection correctly specifies that usernames must be in email format with domain matching, and importantly notes this is a strict requirement during user creation. The progressive detail (format requirement → domain matching → strict enforcement) follows a logical learning curve.
.../organization-management/organization-discovery/email-domain-based-organization-discovery.md
Outdated
Show resolved
Hide resolved
…ery/email-domain-based-organization-discovery.md
.../organization-management/organization-discovery/email-domain-based-organization-discovery.md
Outdated
Show resolved
Hide resolved
This PR was automatically generated by Claude AI.
Issue Details
Summary
Corrected inaccurate documentation that incorrectly stated "Email as Username" is a mandatory prerequisite for Email Domain-Based Organization Discovery. The feature can work without it, with specific requirements for username format during user creation and different login scenarios.
Changes Made
Affected Versions
This single change to the shared include file affects:
All three versions use the same include file (
en/includes/guides/organization-management/organization-discovery/email-domain-based-organization-discovery.md), so one fix updates all versions.Style Scope Verification
Microsoft Style Guidelines have been applied ONLY to newly added content without modifying existing content style unless specifically requested.
Verification
mkdocs buildpassedmkdocs build --strictfails due to pre-existing configuration warnings unrelated to this PR (verified on master branch)Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.